-
Notifications
You must be signed in to change notification settings - Fork 3
feat: rename Error to GridError and add additionalProperties to error schemas #131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split
Are you sure you want to change the base?
Conversation
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Greptile OverviewGreptile SummaryThis PR introduces a new Key Changes:
Architecture Improvement: Minor Issue: Confidence Score: 4/5
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/common/GridError.yaml | New GridError schema created with additionalProperties: true for flexible error details |
| openapi/components/schemas/customers/BulkCustomerImportErrorEntry.yaml | Refactored to extend GridError using allOf composition instead of nesting error structure |
| openapi/components/schemas/webhooks/IncomingPaymentWebhookForbiddenResponse.yaml | Updated to extend GridError instead of Error schema |
| openapi/components/schemas/webhooks/IncomingPaymentWebhookUnprocessableResponse.yaml | Updated to extend GridError instead of Error schema |
| openapi.yaml | Bundled OpenAPI spec with all error schema changes, but missed updating 410 error reference |
| mintlify/openapi.yaml | Copy of bundled spec for Mintlify, contains same 410 error reference issue |
Sequence Diagram
sequenceDiagram
participant API as Grid API
participant Client as API Client
participant Schema as Error Schema
Note over API,Schema: Error Response Flow
Client->>API: Request with potential error
API->>Schema: Generate error response
alt Using GridError (new)
Schema->>Schema: Create GridError object
Schema->>Schema: Add code, message
Schema->>Schema: Add details (additionalProperties: true)
Schema->>API: Return GridError
else Using Error4xx/5xx (updated)
Schema->>Schema: Create specific Error object
Schema->>Schema: Add status, code, message
Schema->>Schema: Add details (additionalProperties: true)
Schema->>API: Return specific Error
else Using BulkCustomerImportErrorEntry
Schema->>Schema: Extend GridError via allOf
Schema->>Schema: Add correlationId field
Schema->>API: Return enriched error
end
API->>Client: Return error response with flexible details
6432728 to
e5749d2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
Additional Comments (1)
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145
Comment:
Incomplete migration: still references `Error.yaml` instead of `GridError.yaml`. For consistency with the rest of this PR, this should be updated to use `GridError.yaml`.
```suggestion
$ref: ../../components/schemas/common/GridError.yaml
```
How can I resolve this? If you propose a fix, please make it concise. |
68ab09c to
5786fb9
Compare
e5749d2 to
a27f6e6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
Additional Comments (1)
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145
Comment:
Inconsistent error schema reference - should use `GridError.yaml` instead of `Error.yaml` to match the PR's goal of standardizing on `GridError`
```suggestion
$ref: ../../components/schemas/common/GridError.yaml
```
How can I resolve this? If you propose a fix, please make it concise. |
5786fb9 to
79467e5
Compare
a27f6e6 to
a1379cd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
Additional Comments (1)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time! Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145
Comment:
Update this to reference `GridError` for consistency with other error responses
```suggestion
$ref: ../../components/schemas/common/GridError.yaml
```
<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>
How can I resolve this? If you propose a fix, please make it concise. |

TL;DR
Added a new
GridErrorschema and improved error handling in the OpenAPI specification.What changed?
GridErrorschema to standardize error responsesadditionalProperties: trueto all error schemadetailsobjects to allow for flexible error detailsBulkCustomerImportErrorEntryto extend fromGridErrorinstead of using a nested error structureGridErrorinstead ofError